//
//  Copyright (c) 2008 Bogozma Electronics Inc.
//
//  @ Project : Bogozma Software Development Kit (SDK)
//  @ File Name : exception_messages.h
//  @ Date : 7/25/2008
//  @ Author : Michael Gozzo (OIQ# 140438)
//
#if !defined(_EXCEPTIONMESSAGES_H)
#define _EXCEPTIONMESSAGES_H



//!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
//!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
//!!!! READ THIS:
//
//     To add a new exception type:
//
//     1) Increment the following value
#define LAST_EXCEPTION_ID           0x00000014
//
//     2) Follow the format used for the other exception types
//         
//     3) Your new exception ID should match be equal to the last exception ID.
//
//     
//!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
//!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!



#define EX_UNSUPPORTED_DEVICE          "Unsupported device type."
#define EX_UNSUPPORTED_DEVICE_ID       0x00000001

#define EX_NULL_DEVICE_INFO            "Cannot set a NULL device info."
#define EX_NULL_DEVICE_INFO_ID         0x00000002

#define EX_BAUD_RATE_INVALID           "The specified baud rate is not supported by the device."
#define EX_BAUD_RATE_INVALID_ID        0x00000003

#define EX_PARITY_INVALID              "The specified parity setting is not supported by the device."
#define EX_PARITY_INVALID_ID           0x00000004

#define EX_DATA_BIT_INVALID            "The specified data bit setting is not supported by the device."
#define EX_DATA_BIT_INVALID_ID         0x00000005

#define EX_STOP_BIT_INVALID            "The specified flow control setting is not supported by the device."
#define EX_STOP_BIT_INVALID_ID         0x00000006

#define EX_FLOW_CONTROL_INVALID        "The specified flow control setting is not supported by the device."
#define EX_FLOW_CONTROL_INVALID_ID     0x00000007

#define EX_UNIMPLEMENTED_FCN           "The requested feature is not currently implemented in the device firmware."
#define EX_UNIMPLEMENTED_FCN_ID        0x00000008

#define EX_NEGATIVE_BUFFER             "A negative buffer size was provided."
#define EX_NEGATIVE_BUFFER_ID          0x00000009

#define EX_NULL_PARAMETER              "A NULL pointer cannot be passed to this function."
#define EX_NULL_PARAMETER_ID           0x0000000A

#define EX_CONTROL_FAILURE             "Failed to open a control channel with the device."
#define EX_CONTROL_FAILURE_ID          0x0000000B

#define EX_STREAM_FAILURE              "Failed to connect to the device's data stream."
#define EX_STREAM_FAILURE_ID           0x0000000C

#define EX_NO_BIND                     "Internal error: Socket not bound."
#define EX_NO_BIND_ID                  0x0000000D

#define EX_NO_CONNECT                  "Internal error: Socket not connected."
#define EX_NO_CONNECT_ID               0x0000000E

#define EX_BAD_PASSWORD                "The specified password is invalid."
#define EX_BAD_PASSWORD_ID             0x0000000F

#define EX_DEVICE_NOT_ONLINE           "The specified device is no longer present on the network."
#define EX_DEVICE_NOT_ONLINE_ID        0x00000010

#define EX_MUST_OPEN                   "You must open the device before attempting this operation."
#define EX_MUST_OPEN_ID                0x00000011

#define EX_CANT_OPEN                   "The selected device could not be openned."
#define EX_CANT_OPEN_ID                0x00000012

#define EX_INVALID_PARAMETER           "An invalid parameter was passed to the function."
#define EX_INVALID_PARAMETER_ID        0x00000013

#define EX_PASS_NOT_SUPPORTED          "This type of device cannot accept password protected connection."
#define EX_PASS_NOT_SUPPORTED_ID       0x00000014


#endif  //_EXCEPTIONMESSAGES_H
